.nh
.TH "NBFC-SERVICE" "1" "MAY 2025" "Notebook FanControl @VERSION@"
.SH NAME
.PP
nbfc_service \- Notebook FanControl service

.SH DESCRIPTION
.PP
NoteBook FanControl service

.SH SYNOPSIS
.PP
.BR nbfc_service
.RI [ OPTIONS ]

.SH OPTIONS
.PP
.BR \-h ", " \-\-help
.RS
Show this help message and exit.
.RE

.PP
.B \-\-version
.RS
Show program's version number and exit.
.RE

.PP
.BR \-r ", " \-\-read\-only
.RS
Start in read\-only mode.
.RE

.PP
.BR \-f ", " \-\-fork
.RS
Switch process to background after sucessfully started.
.RE

.PP
.BR \-d ", " \-\-debug
.RS
Enable tracing of reads and writes of the embedded controller.
.RE

.PP
.BR \-c ", " \-\-config\-file
.I CONFIG
.RS
Use alternative config file (default @SYSCONFDIR@/nbfc/nbfc.json).
.RE

.PP
.B \-e, \-\-embedded\-controller
.RI [ dummy ", " dev_port ", " ec_sys ", " acpi_ec ]
.RS
Specify embedded controller to use.
.IP \(bu 2
.BR ec_sys :
Use the ec_sys kernel module for writing to the embedded controller.
.IP \(bu 2
.BR acpi_ec :
Use the acpi_ec kernel module for writing to the embedded controller.
.IP \(bu 2
.BR dev_port :
Write to the embedded controller using /dev/port.
.IP \(bu 2
.BR dummy :
Don't write to the embedded controller at all.

.RI

.SH FILES
.PP
.I @SYSCONFDIR@/nbfc.json
.RS
The main configuration file for nbfc_service. See
.BR nbfc_service.json (5)
for further details.
.RE

.PP
.I @RUNSTATEDIR@/nbfc_service.pid
.RS
File containing the PID of current running nbfc_service.
.RE

.PP
.I @RUNSTATEDIR@/nbfc_service.socket
.RS
Socket file of nbfc_service.
.RE

.PP
.I @DATADIR@/nbfc/configs/*.json
.RS
Configuration files for various notebook models. See
.BR nbfc_service.json (5)
for further details.
.RE

.I @DATADIR@/nbfc/model_support.json
.RS
Model support database. This file maps notebook model names to configuration files.
.RE

.I /var/lib/nbfc/configs/*.json
.RS
Configuration files downloaded from the internet. Files in this directory take precedence over those in
.IR @DATADIR@/nbfc/configs .
.RE

.I /var/lib/nbfc/model_support.json
.RS
Model support database downloaded from the internet. Both
.I /var/lib/nbfc/model_support.json
and
.I @DATADIR@/nbfc/model_support.json
are taken into account.
.RE

.I /var/lib/nbfc/state.json
.RS
State file of nbfc_service. This holds the current fan speeds.
.RE

.SH EXIT STATUS
.RS
.IP \(bu 2
0    Everything fine
.IP \(bu 2
1    Generic error
.IP \(bu 2
2    Command line error
.IP \(bu 2
3    Initialization error
.IP \(bu 2
5    Fatal error

.RE

.SH BUGS
.PP
Report bugs to https://github.com/nbfc\-linux/nbfc\-linux

.SH AUTHOR
.PP
Benjamin Abendroth (braph93@gmx.de)

.SH SEE ALSO
.PP
.BR nbfc (1),
.BR nbfc_service.json (5),
.BR ec_probe (1),
.BR fancontrol (1)
